<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>papyros.base.TaskQueue</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            >papyros documentation</th>
          </tr></table></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        <a href="papyros-module.html">Package&nbsp;papyros</a> ::
        <a href="papyros.base-module.html">Module&nbsp;base</a> ::
        Class&nbsp;TaskQueue
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
        <tr><td align="right"><span class="options"
            >[<a href="frames.html" target="_top">frames</a
            >]&nbsp;|&nbsp;<a href="papyros.base.TaskQueue-class.html"
            target="_top">no&nbsp;frames</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class TaskQueue</h1><span class="codelink"><a href="papyros.base-pysrc.html#TaskQueue">source&nbsp;code</a></span><br /><br />
<pre class="base-tree">
object --+
         |
        <strong class="uidshort">TaskQueue</strong>
</pre>

<dl><dt>Known Subclasses:</dt>
<dd>
    <a href="papyros.distributed.PyroTaskQueue-class.html">distributed.PyroTaskQueue</a>
</dd></dl>

<hr />
<p>An abstraction of a queue of <a href="papyros.task.Task-class.html" 
  class="link">tasks</a>.</p>
  <p>A <i>TaskQueue</i> is used to <a 
  href="papyros.base.TaskQueue-class.html#push" class="link">push</a> new 
  tasks to be executed and <a href="papyros.base.TaskQueue-class.html#pop" 
  class="link">pop</a> results from finished tasks (or reraise the 
  exception raised during task execution). Task queues should be <a 
  href="papyros.base.TaskQueue-class.html#close" class="link">closed</a> 
  after they are not needed anymore.</p>
  Clients should not instantiate this class directly; they should call 
  <a href="papyros.base.TaskDispatcher-class.html#make_queue" 
  class="link">TaskDispatcher.make_queue</a> instead.<br /><br />

<!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Instance Methods</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-InstanceMethods"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="papyros.base.TaskQueue-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">dispatcher</span>,
        <span class="summary-sig-arg">size</span>=<span class="summary-sig-default">0</span>)</span><br />
      Initialize this task queue.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="papyros.base-pysrc.html#TaskQueue.__init__">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="papyros.base.TaskQueue-class.html#push" class="summary-sig-name">push</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">task</span>,
        <span class="summary-sig-arg">timeout</span>=<span class="summary-sig-default">None</span>)</span><br />
      Add a new <a href="papyros.task-module.html" class="link">Task</a>
      to this task queue.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="papyros.base-pysrc.html#TaskQueue.push">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="papyros.base.TaskQueue-class.html#pop" class="summary-sig-name">pop</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">timeout</span>=<span class="summary-sig-default">None</span>)</span><br />
      Pop a finished <a href="papyros.task-module.html" 
      class="link">Task</a> from this queue.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="papyros.base-pysrc.html#TaskQueue.pop">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">list</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="papyros.base.TaskQueue-class.html#pop_many" class="summary-sig-name">pop_many</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">timeout</span>=<span class="summary-sig-default">0</span>)</span><br />
      Pop several finished tasks within the given timeout.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="papyros.base-pysrc.html#TaskQueue.pop_many">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="papyros.base.TaskQueue-class.html#close" class="summary-sig-name">close</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Release the resources associated with this task queue.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="papyros.base-pysrc.html#TaskQueue.close">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr class="private">
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="papyros.base.TaskQueue-class.html#_get_finished" class="summary-sig-name">_get_finished</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">task</span>)</span><br />
      Push an executed task in the finished queue.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="papyros.base-pysrc.html#TaskQueue._get_finished">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr class="private">
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="papyros.base.TaskQueue-class.html#_get_proxy" class="summary-sig-name">_get_proxy</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Return a proxy to this queue as it is to be known by its 
      dispatcher.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="papyros.base-pysrc.html#TaskQueue._get_proxy">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
  <tr>
    <td colspan="2" class="summary">
    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
      <code>__delattr__</code>,
      <code>__getattribute__</code>,
      <code>__hash__</code>,
      <code>__new__</code>,
      <code>__reduce__</code>,
      <code>__reduce_ex__</code>,
      <code>__repr__</code>,
      <code>__setattr__</code>,
      <code>__str__</code>
      </p>
    </td>
  </tr>
</table>
<!-- ==================== PROPERTIES ==================== -->
<a name="section-Properties"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Properties</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-Properties"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
  <tr>
    <td colspan="2" class="summary">
    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
      <code>__class__</code>
      </p>
    </td>
  </tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></a>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Method Details</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-MethodDetails"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
</table>
<a name="__init__"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">dispatcher</span>,
        <span class="sig-arg">size</span>=<span class="sig-default">0</span>)</span>
    <br /><em class="fname">(Constructor)</em>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="papyros.base-pysrc.html#TaskQueue.__init__">source&nbsp;code</a></span>&nbsp;
    </td>
  </table>
  
  Initialize this task queue.
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>dispatcher</code></strong> - The <a href="papyros.base.TaskDispatcher-class.html" 
          class="link">TaskDispatcher</a> to dispatch tasks pushed in this 
          queue.</li>
        <li><strong class="pname"><code>size</code></strong> - The maximum number of completed tasks waiting to be popped 
          (unlimited by default).</li>
    </ul></dd>
    <dt>Overrides:
      object.__init__
    </dt>
  </dl>
</td></tr></table>
</div>
<a name="push"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">push</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">task</span>,
        <span class="sig-arg">timeout</span>=<span class="sig-default">None</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="papyros.base-pysrc.html#TaskQueue.push">source&nbsp;code</a></span>&nbsp;
    </td>
  </table>
  
  Add a new <a href="papyros.task-module.html" class="link">Task</a> to 
  this task queue.
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>timeout</code></strong> - If <code>timeout is None</code> and the queue's dispatcher is 
          full, wait until a slot becomes available. If <code>timeout &gt; 
          0</code> and the dispatcher remains full after 
          <code>timeout</code> seconds, or if <code>timeout &lt;= 0</code> 
          and the dispatcher is full now, raise <a 
          href="papyros.TimeoutError-class.html" 
          class="link">TimeoutError</a>.</li>
    </ul></dd>
    <dt>Raises:</dt>
    <dd><ul class="nomargin-top">
        <li><code><strong class='fraise'><a href="papyros.TimeoutError-class.html">TimeoutError</a></strong></code> - If <code>timeout</code> expires before pushing the task.</li>
        <li><code><strong class='fraise'><a href="papyros.base.ClosedTaskQueueError-class.html">ClosedTaskQueueError</a></strong></code> - If the queue has been closed.</li>
    </ul></dd>
  </dl>
</td></tr></table>
</div>
<a name="pop"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">pop</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">timeout</span>=<span class="sig-default">None</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="papyros.base-pysrc.html#TaskQueue.pop">source&nbsp;code</a></span>&nbsp;
    </td>
  </table>
  
  Pop a finished <a href="papyros.task-module.html" 
  class="link">Task</a> from this queue.
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>timeout</code></strong> - If <code>timeout is None</code> and there are no pending 
          finished tasks, wait until one finishes. If <code>timeout &gt; 
          0</code> and no task has finished within <code>timeout</code> 
          seconds, or if <code>timeout &lt;= 0</code> and no finished task 
          is available immediately, raise <a 
          href="papyros.TimeoutError-class.html" 
          class="link">TimeoutError</a>.</li>
    </ul></dd>
    <dt>Returns:</dt>
        <dd>The result of a finished task.</dd>
    <dt>Raises:</dt>
    <dd><ul class="nomargin-top">
        <li><code><strong class='fraise'><a href="papyros.TimeoutError-class.html">TimeoutError</a></strong></code> - If <code>timeout</code> expires before poping a task.</li>
        <li><code><strong class='fraise'><a href="papyros.base.ClosedTaskQueueError-class.html">ClosedTaskQueueError</a></strong></code> - If the queue has been closed.</li>
        <li><code><strong class='fraise'>Exception</strong></code> - Any exception raised when executing the task is reraised 
        here.</li>
    </ul></dd>
  </dl>
</td></tr></table>
</div>
<a name="pop_many"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">pop_many</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">timeout</span>=<span class="sig-default">0</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="papyros.base-pysrc.html#TaskQueue.pop_many">source&nbsp;code</a></span>&nbsp;
    </td>
  </table>
  
  Pop several finished tasks within the given timeout.
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>timeout</code></strong> - Keep popping finished tasks for <code>timeout</code> seconds. 
          If <code>timeout &lt;= 0</code>, pop all currently finished 
          tasks.</li>
    </ul></dd>
    <dt>Returns: list</dt>
        <dd>The results of the finished tasks within the given 
          timeout.</dd>
    <dt>Raises:</dt>
    <dd><ul class="nomargin-top">
        <li><code><strong class='fraise'><a href="papyros.base.ClosedTaskQueueError-class.html">ClosedTaskQueueError</a></strong></code> - If the queue has been closed.</li>
        <li><code><strong class='fraise'>Exception</strong></code> - Any exception raised when executing any of the popped tasks.</li>
    </ul></dd>
  </dl>
</td></tr></table>
</div>
<a name="close"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">close</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="papyros.base-pysrc.html#TaskQueue.close">source&nbsp;code</a></span>&nbsp;
    </td>
  </table>
  
  <p>Release the resources associated with this task queue.</p>
  A subsequent attempt to modify the queue raises <a 
  href="papyros.base.ClosedTaskQueueError-class.html" 
  class="link">ClosedTaskQueueError</a>.
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="_get_finished"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">_get_finished</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">task</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="papyros.base-pysrc.html#TaskQueue._get_finished">source&nbsp;code</a></span>&nbsp;
    </td>
  </table>
  
  <p>Push an executed task in the finished queue.</p>
  Should be called by a <a href="papyros.base.Worker-class.html" 
  class="link">Worker</a> only.
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="_get_proxy"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">_get_proxy</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="papyros.base-pysrc.html#TaskQueue._get_proxy">source&nbsp;code</a></span>&nbsp;
    </td>
  </table>
  
  <p>Return a proxy to this queue as it is to be known by its 
  dispatcher.</p>
  Basically added to support Pyro task queues; this implementation just 
  returns self.
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            >papyros documentation</th>
          </tr></table></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0beta1 on Tue Aug 12 05:39:45 2008
    </td>
    <td align="right" class="footer">
      <a href="http://epydoc.sourceforge.net">http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie()
  // -->
</script>
  
</body>
</html>
